Skip to content

Updating an existing Holiday Calendar Membership

Request

This endpoint returns structured Holiday Calendar Membership objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the holiday_calendar_memberships top-level JSON key. Please see our Response Format section for more information.

Path
idintegerrequired

The ID of the Model.

Query
includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • holiday_calendar (HolidayCalendar) - The Holiday Calendar associated with this HolidayCalendarMembership.
  • user (User) - The User participating in the Holiday Calendar.
Bodyapplication/jsonrequired
holiday_calendar_membershipobject
{
  "holiday_calendar_membership": {
    "start_date": "2019-08-24",
    "holiday_calendar_id": 0
  }
}

Responses

Holiday Calendar Membership has been updated.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
holiday_calendar_membershipsobject
holiday_calendarsobject
usersobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "holiday_calendar_memberships": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "end_date": "2019-08-24",
      "holiday_calendar_id": "string",
      "in_use": true,
      "start_date": "2019-08-24",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": 0
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "end_date": "2019-08-24",
      "holiday_calendar_id": "string",
      "in_use": true,
      "start_date": "2019-08-24",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": 0
    }
  },
  "holiday_calendars": {
    "property1": {
      "default": true,
      "name": "string"
    },
    "property2": {
      "default": true,
      "name": "string"
    }
  },
  "users": {
    "property1": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    },
    "property2": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    }
  }
}